Snapservice ProtectionGroupUpdateSpec
The Snapservice ProtectionGroupUpdateSpec schema contains properties that describe the desired protection group and the snapshot policies associated with it. A protection group is a group of entities that vSAN Snapshot Service protects together.
This schema was added in vSphere API 8.0.3.0.
{
"name": "string",
"target_entities": {
"vm_name_patterns": [
"string"
],
"vms": [
"string"
],
"tag_rules": [
{
"tags": [
"string"
],
"operator": "string"
}
]
},
"snapshot_policies": [
{
"name": "string",
"schedule": {
"unit": "string",
"interval": 0
},
"retention": {
"unit": "string",
"duration": 0
}
}
],
"replication_policies": [
{
"cluster_pair": "string",
"recovery_point_objective": {
"unit": "string",
"duration": 0
},
"snapshot_retention": {
"short_term": {
"keep_last": 0
},
"long_term": {
"hourly": {
"retention": {
"unit": "string",
"duration": 0
}
},
"daily": {
"hour": 0,
"retention": {
"unit": "string",
"duration": 0
}
},
"weekly": {
"hour": 0,
"day_of_week": "string",
"retention": {
"unit": "string",
"duration": 0
}
},
"monthly": {
"hour": 0,
"day_of_month": 0,
"retention": {
"unit": "string",
"duration": 0
}
}
}
},
"use_replica_seed": false,
"storage_spec": {
"target_datastore": "string"
},
"target_entity_replication_spec": {
"vm_replication_specs": [
{
"vm": "string",
"config_params": {
"target_config": {
"use_replica_seed": false,
"storage_spec": {
"target_datastore": "string"
}
}
}
}
]
}
}
],
"locked": false
}Name of the protection group.
This property was added in vSphere API 8.0.3.0.
if missing or null, the current proteciton group name will be retained.
Target entities for the protection. If set, this will represent all the target entities for the protection group.
This property was added in vSphere API 8.0.3.0.
if missing or null, the existing target entities will be retained.
Snapshot policy for the protection targets. If set, this will represent all the snapshot policies for the protection group. Any existing policies will be removed, if not specified in the new list.
This property was added in vSphere API 8.0.3.0.
if missing or null, existing snapshot policies will be retained.
Replication policies for the protection group.
This property was added in vSphere API 9.0.0.0.
Set if replication needs to be configured. Currently only one policy is supported
Indicates if the protection group is to be locked. A locked protection group cannot be modified or deleted by the user. All snapshots associated with the protection group will be secure and cannot be deleted. The system will automatically delete these snapshots upon expiry based on the retention period.
Setting this field to false for an immutable protection group will not be supported.
This property was added in vSphere API 9.1.0.0.
if missing or null, existing configuration will be retained.